eLab posistemės integracijos dokumentacija
0.3.1 - versija
eLab posistemės integracijos dokumentacija - Local Development build (v0.3.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
GET /fhir/CodeSystem/{id}
- naujausios nomenklatūros gavimas pagal id.GET /fhir/CodeSystem/{id}/_history
- nomenklatūros pakeitimų istorijos gavimas pagal id.GET /fhir/CodeSystem/{id}/_history/{versija}
- specifinės nomenklatūros versijos gavimas pagal id ir istorinės versijos id.GET /fhir/CodeSystem/_search?system={klasifikatoriausTipas}&version={klasifikatoriausVersija}
- nomenklatūrų paieška pagal nomenklatūrų sistemą ir versiją.GET /fhir/CodeSystem/{id}/$diff?fromVersion={senesnėVersija}&toVersion={naujesnėVersija}
- nomenklatūros pasikeitimų palyginimas tarp dviejų jos versijų.GET /fhir/CodeSystem/{id}/$check-version?version={versija}
- patikrinimas ar yra naujesnė negu pateikta, nomenklatūros versija.GET /fhir/CodeSystem/$lookup?system={sistemosUrl}&code={nomenklatūrosKodas}
- specifinės nomenklatūros reikšmės informacijos gavimas.Šiuo metu Elab sistemoje naudojamų nomenklatūrų informaciją galima gauti naudojantis GET /fhir/CodeSystem/{id}
API
sąsaja. Galimos id reikšmės yra tokios:
Pavadinimas | Sistemos URL | Paskirtis |
---|---|---|
lt-klt-nomenklatura |
https://lmb.lt/CodeSystem/lt-klt-nomenklatura |
Laboratorinių tyrimų klasifikatorius |
lt-processed-specimen |
https://lmb.lt/CodeSystem/lt-processed-specimen |
Mėginio tipas |
lt-collected-specimen |
https://lmb.lt/CodeSystem/lt-collected-specimen |
Ėminio tipas |
lt-methods |
https://lmb.lt/CodeSystem/lt-methods |
Tyrimo analizės metodas |
lt-scale |
https://lmb.lt/CodeSystem/lt-scale |
Tyrimo matavimo skalė (kiekybinė, kokybinė ir pan.) |
lt-test-group |
https://lmb.lt/CodeSystem/lt-test-group |
Tyrimų grupė |
bodyPosition |
http://esveikata.lt/Classifiers/BodyPosition |
Kūno padėtis, ėminio ėmimo metu |
Visi integraciniai taškai palaiko duomenų apsikeitimą tiek XML tiek JSON formatais. Rekomenduojamas apsikeitimo
formatas - JSON. Norint naudotis XML duomenų apsikeitimu formatu tą reikia nurodyti užklausoje naudojantis _format
parametru, daugiau informacijos galima rasti čia.
GET /fhir/CodeSystem/{id}
- naujausios nomenklatūros gavimas pagal id.Pateikiama naujausia klasifikatoriaus versija. Grąžinamas CodeSystem resursas.
Laukas | Aprašymas |
---|---|
resourceType |
Grąžinamo resurso tipas |
id |
Identifikatorius |
meta |
Metaduomenys - versija ir atnaujinimo data |
text |
Išsamus aprašymas |
url |
Resurso nuoroda |
version |
Resurso versija |
name |
Resurso pavadinimas |
status |
Resurso būsena |
Date |
Sukūrimo data |
description |
Trumpas aprašymas |
caseSensitive |
Žymė, nurodanti, ar klasifikatorius skiria mažąsias ir didžiąsias raides |
content |
Klasifikatoriaus turinio būsena |
concept |
Klasifikatoriaus elementų sąrašas |
code |
Elemento kodas |
display |
Elemento atvaizdavimas |
definition |
Elemento aprašymas |
designation |
Papildoma informacija apie elementą |
Pavyzdys: GET /fhir/CodeSystem/lt-processed-specimen
- atsakymas.
GET /fhir/CodeSystem/{id}/_history
- nomenklatūros pakeitimų istorijos gavimas pagal id.Pateikiamos visos klasifikatoriaus versijos, įskaitant ir naujausią. Grąžinamas Bundle tipo resursas.
Laukas | Aprašymas |
---|---|
resourceType |
Resurso tipas |
id |
Paieškos id |
meta |
Metaduomenys |
total |
Rezultatų kiekis |
entry |
Įrašų sąrašas |
Pavyzdys: GET /fhir/CodeSystem/lt-processed-specimen/_history
- atsakymas.
GET /fhir/CodeSystem/{id}/_history/{versija}
- specifinės nomenklatūros versijos gavimas pagal id ir istorinės versijos id.Pateikiama konkreti istorinė klasifikatoriaus versija. Klasifikatoriaus versija
turi būti nurodoma tokia, kokia yra saugoma laukelyje meta.versionId
. Grąžinamas CodeSystem tipo resursas.
Pavyzdys: GET /fhir/CodeSystem/lt-processed-specimen/_history/1
- atsakymas.
GET /fhir/CodeSystem/_search?system={klasifikatoriausTipas}&version={klasifikatoriausVersija}
- nomenklatūrų paieška pagal nomenklatūrų sistemą ir versiją.Pateikiamas klasifikatorius pagal nurodytą klasifikatoriaus tipą ir versiją. Labai svarbu atkreipti dėmesį į tai, kad
šioje užklausoje yra naudojama ne FHIR versija, bet versija, esantį nomenklatūros version
lauke. Grąžinamas Bundle
tipo resursas.
Pavyzdys: GET /fhir/CodeSystem/_search?system=https://lmb.lt/CodeSystem/lt-processed-specimen&version=1.0.0
- atsakymas.
GET /fhir/CodeSystem/{id}/$diff?fromVersion={senesnėVersija}&toVersion={naujesnėVersija}
- nomenklatūros pasikeitimų palyginimas tarp dviejų jos versijų.Pateikiami pokyčiai tarp klasifikatoriaus FHIR versijų. Galima nurodyti parametrus fromVersion
- nuo kokios
versijos lyginama, ir toVersion
- su kokia versija lyginama. Jeigu nenurodomas fromVersion
, lyginama nuo
priešpaskutinės naujausios versijos. Jeigu nenurodomas toVersion
, lyginama su naujausia versija. Versija turi būti
nurodoma iš resurso metadata.version
lauko. Grąžinamas Parameters tipo resursas.
Laukas | Aprašymas |
---|---|
resourceType |
Resurso tipas |
parameter |
Parametrų sąrašas |
name |
Parametro pavadinimas |
part |
Operaciją aprašančios dalys, susidedančios iš dalies pavadinimo ir vertės. type - operacijos tipas. Replace - pakeitimas, insert - naujas įrašas, delete - ištrintas įrašas. path - kelias iki parametro, kuriame įvyko pakeitimas. previousValue - buvusi reikšmė (fromVersion versijoje). value - esama reikšmė (toVersion versijoje). |
Pavyzdys: GET /fhir/CodeSystem/lt-processed-specimen/$diff?fromVersion=1&toVersion=2
- atsakymas.
GET /fhir/CodeSystem/{id}/$check-version?version={versija}
- patikrinimas ar yra naujesnė negu pateikta, nomenklatūros versija.Pateikiamas atsakymas, ar egzistuoja naujesnė klasifikatoriaus versija, nei nurodyta parametre version
. Versija turi
būti nurodoma pagal resurso metadata.version
lauką. Grąžinamas Parameters tipo resursas.
Laukas | Aprašymas |
---|---|
resourceType |
Resurso tipas |
parameter |
Parametrų sąrašas. Parametrus sudaro parametro pavadinimas ir vertė. isNewerVersionAvailable - parametras nurodo, ar yra naujesnė resurso versija, nei nurodyta. |
Pavyzdys: GET /fhir/CodeSystem/lt-processed-specimen/$check-version?version=1
- atsakymas.
GET /fhir/CodeSystem/$lookup?system={sistemosUrl}&code={nomenklatūrosKodas}
- specifinės nomenklatūros reikšmės informacijos gavimas.Pateikiamas vienas konkretus elementas iš nurodyto klasifikatoriaus pagal klasifikatoriaus kodą. system
-
klasifikatoriaus tipas (pagal CodeSystem url parametrą), code
- norimo elemento kodas. Grąžinamas Parameters tipo
resursas.
Laukas | Aprašymas |
---|---|
resourceType |
Resurso tipas |
parametrai |
Parametrų sąrašas. name - klasifikatoriaus pavadinimas. version - klasifikatoriaus versija. display - elemento pavadinimas. designation - papildomi parametrai. |
Pavyzdys: GET /fhir/CodeSystem/$lookup?code=https://lmb.lt/CodeSystem/lt-processed-specimen&code=PRP
- atsakymas.